Skip to content

Add RDoc task for local documentation coverage checks#71

Open
kanutocd wants to merge 1 commit into
ruby:masterfrom
kanutocd:feature/add-rdoc-task
Open

Add RDoc task for local documentation coverage checks#71
kanutocd wants to merge 1 commit into
ruby:masterfrom
kanutocd:feature/add-rdoc-task

Conversation

@kanutocd

Copy link
Copy Markdown
Contributor

Summary

Add an RDoc::Task and the rdoc development dependency so contributors can run the documentation coverage check locally:

bundle exec rake rdoc:coverage

This exposes the RDoc documentation coverage task locally. It can help contributors identify documentation coverage issues before changes are synchronized into ruby/ruby.

Changes

  • add rdoc as a development dependency
  • register RDoc::Task
  • expose bundle exec rake rdoc:coverage

Example

$ bundle exec rake rdoc:coverage

100.00% documented

Scope

This change only exposes the existing RDoc task locally.

It does not:

  • change the default Rake tasks
  • add or modify CI
  • introduce any new contributor requirements

@kanutocd
kanutocd force-pushed the feature/add-rdoc-task branch from 436fc97 to ada6211 Compare July 20, 2026 10:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant